Skip to content

docs: fix unexported function names in svd doc #1151

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Dec 20, 2024
Merged

docs: fix unexported function names in svd doc #1151

merged 2 commits into from
Dec 20, 2024

Conversation

@inkydragon
Copy link
Member

@inkydragon inkydragon commented Dec 20, 2024 •
edited
Loading

QRIteration() is not exported, so I updated the svd.jl documentation section that suggests such a method exists for the svd function. Now it says to use alg = LinearAlgebra.QRIteration() instead of alg = QRIteration() which would produce an error before.

julia> VERSION
v"1.11.2"

julia> using LinearAlgebra

julia> DivideAndConquer
ERROR: UndefVarError: `DivideAndConquer` not defined in `Main`
Suggestion: check for spelling errors or missing imports.

julia> QRIteration
ERROR: UndefVarError: `QRIteration` not defined in `Main`
Suggestion: check for spelling errors or missing imports.

julia> LinearAlgebra.DivideAndConquer
LinearAlgebra.DivideAndConquer

julia> LinearAlgebra.QRIteration
LinearAlgebra.QRIteration

Moved from JuliaLang/julia#56611

CNOT and others added 2 commits December 20, 2024 18:06
@CNOT @inkydragon
Update svd.jl documentation
fa55113 
QRIteration() is not exported, so I updated the svd.jl documentation section that suggests such a method exists for the `svd` function. Now it says to use `alg = LinearAlgebra.QRIteration()` instead of `alg = QRIteration()` which would produce an error before.

Signed-off-by: Chengyu HAN <[email protected]>
@inkydragon
doc: fix doc for svd
334a928
@codecov
Copy link

codecov bot commented Dec 20, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.88%. Comparing base (1137b4c) to head (334a928).
Report is 1 commits behind head on master.

Additional details and impacted files 
@@            Coverage Diff             @@
##           master    #1151      +/-   ##
==========================================
+ Coverage   91.81%   91.88%   +0.07%     
==========================================
  Files          34       34              
  Lines       15342    15339       -3     
==========================================
+ Hits        14087    14095       +8     
+ Misses       1255     1244      -11

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@jishnub jishnub merged commit 39a7e3c into JuliaLang:master Dec 20, 2024
4 checks passed
@inkydragon inkydragon deleted the doc-svd branch December 20, 2024 11:05
@inkydragon inkydragon mentioned this pull request Dec 20, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@inkydragon @jishnub @CNOT